Add db and pool Metrics Swagger coverage and examples#1284
Add db and pool Metrics Swagger coverage and examples#1284olydis merged 6 commits intoAzure:masterfrom
Conversation
…Definitions to metrics.json
|
@nathannfan Please add security definitions as described here (see https://github.com/Azure/azure-rest-api-specs/search?q=securityDefinitions for typical structure within Swagger) to all of your Swaggers 🙂 |
|
not sure about your SDK/CLI release state, but be aware of the breaking changes (at least due to renaming of types) introduced here |
|
@olydis Jared added them to all of them already, so I added them to my new file. |
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: File: File: Thanks for your co-operation. |
|
@olydis not sure why I'm failing validation for ruby. Any ideas? |
|
I think the ruby build is broken |
|
@jaredmoo seems so :( will check with the Ruby people, but we can go on here independently for the time being |
| "in": "query", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "An OData filter expression that describes a subset of metrics to return. Required for getting metrics." |
There was a problem hiding this comment.
General guideline: don't repeat things like requiredness in the description. For generated SDKs, imagine a method ListMetrics with a regular (non-optional) parameter filter with a description Required for getting metrics.. You would probably think "Yeah, obviously..."
| "in": "query", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "An OData filter expression that describes a subset of metrics to return. Required for getting metrics." |
There was a problem hiding this comment.
see above, remove Required for getting metrics.
| } | ||
| }, | ||
| "name": { | ||
| "$ref": "#/definitions/MetricName", |
There was a problem hiding this comment.
think you wanna tag those $refed properties as readOnly too :)
There was a problem hiding this comment.
My bad. I thought you meant tagging the properties in the $ref'd definitions "required," not the $ref themselves
olydis
left a comment
olydis
left a comment
There was a problem hiding this comment.
minor comments. as always, very high quality! 👍
| }, | ||
| "required": ["value"], | ||
| "description": "Represents the response to a list server metrics request." | ||
| "description": "The Impact of an operation, both in absolute and relative terms." |
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: File: File: Thanks for your co-operation. |
|
@olydis thanks, Johannes! |
|
No modification for NodeJS |
6 participants
Add database and elastic pool metric swagger coverage and examples. Move usages to usages.json.
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-versionin the path should match theapi-versionin the spec).Quality of Swagger